home *** CD-ROM | disk | FTP | other *** search
/ Video Toaster 4.0 / Video Toaster v4.0.iso / programs / documentation / cgarexx.doc next >
Text File  |  1995-03-11  |  3KB  |  152 lines
  1. Tentative ToasterCG Arexx commands
  2.  
  3. * NOTE: These commands are subject to change, they may not all be fully implemented
  4. or bug free, and there will certainly be more forthcoming.  If there are
  5. bugs, or missing commands please let me (Arnie) know ASAP.
  6.  
  7. Sat Oct 15 14:22:41 1994
  8.  
  9. GET_CHAR() -- Returns current character as a single letter string.
  10. GET_CHAR(SPOT)  -- Returns current char position
  11. GET_CHAR(FACE)  -- Returns current char's font name ***
  12. GET_CHAR(SIZE)  -- Returns char's width (dx)
  13. GET_CHAR(FIRST) -- Returns first char on current line
  14. GET_CHAR(LAST)  -- Returns last char on current line
  15. GET_CHAR(NEXT)  -- Returns next char on current line
  16. GET_CHAR(PREV)  -- Returns previous char on current line
  17. GET_CHAR(RGBA)  -- Returns current char's (top) color
  18. GET_CHAR(TOPR)  -- Returns current char's (top) color
  19. GET_CHAR(BOTR)  -- Returns current char's bottom color
  20. GET_CHAR(STAT)  -- Returns 1 if character is selected
  21.  
  22. GET_BORD(SIZE)
  23. GET_BORD(RGBA)
  24. GET_BORD(PRIO)
  25.  
  26. GET_SHAD(TYPE)
  27. GET_SHAD(PRIO)
  28. GET_SHAD(SIZE)
  29. // GET_SHAD(TOPR)
  30. GET_SHAD(RGBA)
  31. //GET_SHAD(BOTR)
  32.  
  33. GET_FONT()      -- Returns current char's font name
  34. GET_FONT(TYPE)
  35. GET_FONT(SIZE)
  36. GET_FONT(name,[size]) -- Returns an available size of font named,
  37. GET_FONT(NEXT) /* Get's next font from list */
  38. GET_FONT(FIRST) /* Reset's back to the first font */
  39.  
  40. GET_RECT(SPOT)
  41. GET_RECT(SIZE)
  42. GET_RECT(PRIO)
  43. GET_RECT(TOPR)
  44. GET_RECT(RGBA)
  45. GET_RECT(BOTR)
  46.  
  47. GET_PAGE()      // return number
  48. GET_PAGE(FIRST)
  49. GET_PAGE(LAST)
  50. GET_PAGE(NEXT)
  51. GET_PAGE(PREV)
  52. GET_PAGE(TYPE)
  53. GET_PAGE(SIZE)
  54. GET_PAGE(BACK)
  55.  
  56. GET_LINE()
  57. GET_LINE(FIRST)
  58. GET_LINE(LAST)
  59. GET_LINE(NEXT)
  60. GET_LINE(PREV)
  61. GET_LINE(TYPE)
  62. GET_LINE(SIZE)
  63. GET_LINE(JUST)
  64. GET_LINE(SPOT)
  65.  
  66.  
  67.  
  68. /*  SET_ line, char, page, etc sets current object then PICK selects that object,
  69.   or selects relative to that object (i.e. SET_ line number, PICK a char in
  70.   that line). SET_ in the case of pages or attributes actually changes the page#
  71.   or changes attrs of the selected object(s)
  72.  
  73. */
  74.  
  75.  
  76. (change character values with Make/Kill char)
  77. SET_CHAR(FACE,name)
  78. SET_CHAR(TOPR,r,g,b,a)
  79. SET_CHAR(BOTR,r,g,b,a)
  80. SET_CHAR(RGBA,r,g,b,a)
  81.  
  82. SET_BORD(SIZE,#)
  83. SET_BORD(RGBA,r,g,b,a)
  84. SET_BORD(PRIO,T|B)
  85.  
  86. SET_SHAD(TYPE,D|C)
  87. SET_SHAD(PRIO,T|B)
  88. SET_SHAD(SIZE,#)
  89. SET_SHAD(RGBA,r,g,b,a)
  90.  
  91. SET_RECT(SPOT,x,y)
  92. SET_RECT(SIZE,x,y)
  93. SET_RECT(PRIO,T|B)
  94. SET_RECT(RGBA,r,g,b,a)
  95.  
  96. SET_PAGE(#)
  97. SET_PAGE(FIRST)
  98. SET_PAGE(LAST)
  99. SET_PAGE(NEXT)
  100. SET_PAGE(PREV)
  101. SET_PAGE(TYPE)
  102. SET_PAGE(BACK)
  103.  
  104. SET_LINE(#)
  105. SET_LINE(FIRST)
  106. SET_LINE(LAST)
  107. SET_LINE(NEXT)
  108. SET_LINE(PREV)
  109. SET_LINE(TYPE)
  110. SET_LINE(JUST,L|R|C|N)
  111. SET_LINE(SPOT)
  112.  
  113. PICKPAGE([#])     // selects whole current page (jumps to it if # supplied)
  114. PICKLINE([#])     // selects whole current line (sets new current if # supplied)
  115. PICKCHAR([NOT]) //  Pick current char, deselect if arg provided
  116.  
  117. <<LOADPAGE(name)>>
  118. LOADBOOK(name)
  119. LOADBRUSH(name)
  120. LOADFONT(name)
  121. LOADTEXT(name)
  122. LOADPICT(name)
  123.  
  124. <<SAVEPAGE(name)>>
  125. SAVEBOOK(name)
  126. SAVETEXT(name)
  127.  
  128. MAKECHAR(letter)
  129. MAKELINE(text)
  130. MAKERECT(x,y,w,h)
  131. MAKEPAGE([#])
  132. MAKEBOOK(name)
  133.  
  134. KILLCHAR([#])
  135. KILLLINE([#])
  136. KILLPAGE([#])
  137. { KILLBOOK() // maybe you should just delete a file!
  138.  
  139. Misc commands
  140.  
  141. EXIT() // Translates all pages into Farsi and pig-latinizes them before CG exits
  142. RENDER([M|P]) // Main or Preview
  143. REQ_FILE(title,[dir,[name]])
  144. REQ_DIR(title,[dir])
  145. REQ_STRING(title,[default])
  146. REQ_NUMBER(title,[default])
  147. REQ_ASK(title,[title2,[title3]])
  148. REQ_TELL(title,[title2,[title3]])
  149.  
  150. REXX(macro)
  151.  
  152.